Vcenter Guest ConfigurationSpec

Vcenter Guest ConfigurationSpec
Vcenter Guest ConfigurationSpec

The Vcenter Guest ConfigurationSpec schema specifies the settings for customizing a guest operating system.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "windows_config": {
        "reboot": "string",
        "sysprep": {
            "gui_run_once_commands": [
                "string"
            ],
            "user_data": {
                "computer_name": {
                    "type": "string",
                    "fixed_name": "string",
                    "prefix": "string"
                },
                "full_name": "string",
                "organization": "string",
                "product_key": "string"
            },
            "domain": {
                "type": "string",
                "workgroup": "string",
                "domain": "string",
                "domain_username": "string",
                "domain_password": "string",
                "domain_ou": "string"
            },
            "gui_unattended": {
                "auto_logon": false,
                "auto_logon_count": 0,
                "password": "string",
                "time_zone": 0
            }
        },
        "sysprep_xml": "string"
    },
    "linux_config": {
        "hostname": {
            "type": "string",
            "fixed_name": "string",
            "prefix": "string"
        },
        "domain": "string",
        "time_zone": "string",
        "script_text": "string",
        "compatible_customization_method": "string"
    },
    "cloud_config": {
        "type": "string",
        "cloudinit": {
            "metadata": "string",
            "userdata": "string"
        }
    }
}
windows_config
Optional

Guest customization specification for a Windows guest operating system

This property was added in vSphere API 7.0.0.0.

If missing or null, Vcenter Guest ConfigurationSpec.linux_config or Vcenter Guest ConfigurationSpec.cloud_config must be set. Otherwise, an appropriate fault will be thrown.

linux_config
Optional

Guest customization specification for a linux guest operating system

This property was added in vSphere API 7.0.0.0.

If missing or null, Vcenter Guest ConfigurationSpec.windows_config or Vcenter Guest ConfigurationSpec.cloud_config must be set. Otherwise, an appropriate fault will be thrown.

cloud_config
Optional

Guest customization specification with cloud configuration.

This property was added in vSphere API 7.0.3.0.

If missing or null, Vcenter Guest ConfigurationSpec.windows_config or Vcenter Guest ConfigurationSpec.linux_config must be set. Otherwise, an appropriate fault will be thrown.